Skip to content

v3.1.2: Fix Link Object subsections, improve examples #4868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 17, 2025

Conversation

handrews
Copy link
Member

Note: This was found due to issue #4831 which shows the current TOC for 3.2. This part also applies to 3.1, so I'm putting it here first and will forward-port it after merge.

There were two subsections called "Examples", one for actual Link Object examples and one for runtime expression examples. This puts the operationRef examples under the main Examples section, and renames the runtime expression example section.

While I was at it, I clarified some of the wording.

  • schema changes are included in this pull request
  • schema changes are needed for this pull request but not done yet
  • no schema changes are needed for this pull request

There were two subsections called "Examples", one for actual
Link Object examples and one for runtime expression examples.
This puts the `operationRef` examples under the main Examples
section, and renames the runtime expression example section.

While I was at it, I clarified some of the wording.
@handrews handrews added this to the v3.1.2 milestone Aug 14, 2025
@handrews handrews requested review from a team as code owners August 14, 2025 17:08
@handrews handrews added links examples requests for more or better examples in the specification clarification requests to clarify, but not change, part of the spec editorial Wording and stylistic issues labels Aug 14, 2025
Copy link
Contributor

@ralfhandl ralfhandl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, only one left-over character

Co-authored-by: Ralf Handl <[email protected]>
@ralfhandl ralfhandl requested a review from a team August 17, 2025 12:05
Copy link
Contributor

@lornajane lornajane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, I really like the small clarifications!

@lornajane lornajane merged commit ef3b20b into OAI:v3.1-dev Aug 17, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarification requests to clarify, but not change, part of the spec editorial Wording and stylistic issues examples requests for more or better examples in the specification links
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants